/*
Automatic clinic tests using a robot arm.
Copyright (C) 2010  CIC-CPC, CHU Gabriel Montpied
All other trademarks, logos and copyrights are the property
of their respective owners.

This file is part of cpc-painbot.

cpc-painbot is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

cpc-painbot is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with cpc-painbot.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef COMMANDECARACTERES_H
#define COMMANDECARACTERES_H
#include "commande/commande.h"

namespace commande {
namespace bras {
/*! Une Commande au format caractères.
    Une CommandeCaracteres est définie comme suit :
    \@\<Commande\>\<Sous-commande\>[,\<param\>...]\<CR\>
    Le tout transmis au format ascii.

    Ces commandes sont toujours en tandem commande - réponse,
    la réponse étant soit une erreur, soit le même code en minuscule.
*/
class Caracteres : public Commande
{
public:
    /*! Méthode Fabrique.
        Permet de générer des CommandeCaracteres à partir de leur
        représentation telle que reçue au travers du lien RS232.

        \param[in] chaine Une chaîne représentant une commande.

        \retval 0 Si la chaine ne représente pas une commande.
        \retval Caracteres* Une nouvelle Commande correspondant à la chaîne reçue.
    */
    static Caracteres * lire(const QString & chaine);

    //! Format des commandes.
    static const QRegExp format;

    /*! Construit une commande de type 'caractères'.
        Celle-ci est construite à partir de son code et d'une liste d'arguments.
        Lorsque la commande est générée, les délimiteurs
        - \@ en début et \<CR\> en fin - sont ajoutés, et les arguments sont concaténés
        avec des virgules.

        \param[in]    code    Le code de la commande.
        \param[in]    args    Les arguments associés.
    */
    Caracteres(const QString & code,
                            const QStringList & args = QStringList());

    //!< Génère la commande.
    QString generer() const;
};

} // namespace bras
} // namespace commande

#endif // COMMANDECARACTERES_H
